Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(protocol-designer,shared-data): add description to liquid classes #17602

Open
wants to merge 6 commits into
base: edge
Choose a base branch
from
Open

feat(protocol-designer,shared-data): add description to liquid classes #17602

wants to merge 6 commits into from
+120 −43

Conversation

ncdiehl11
Copy link
Collaborator

@ncdiehl11 ncdiehl11 commented Feb 27, 2025 •
edited
Loading

Overview

Here, I add a required description field to liquid class schema, definitions, TS interface, and pydantic model. I also implement this description in DefineLiquidsModal, and ensure we are getting all current liquid class definitions in getAllLiquidClassDefs.

Closes AUTH-1494

Test Plan and Hands on Testing

  • check liquid class definitions and schema
  • create or import a protocol, and select or define a new liquid
  • click the dropdown menu and verify that the liquid class options show correct name and parenthesized description
Screenshot 2025-02-27 at 10 53 24 AM
  • select a liquid class and save
  • navigate to protocol overview page > Liquid Definitions and verify that tag shows correct display name
Screenshot 2025-02-27 at 10 58 04 AM

Changelog

  • update liquid class schema and definitions (displayName and new description)
  • wire up definition in DefineLiquidsModal

Review requests

see test plan

Risk assessment

low

@ncdiehl11
feat(protocol-designer,shared-data): add description to liquid classes
3c0bfcc 
Here, I add a required description field to liquid class schema, definitions, and TS interface. I also implement this description in DefineLiquidsModal, and ensure we are getting all current liquid class definitions in `getAllLiquidClassDefs`.

Closes AUTH-1494
@codecov Codecov
Copy link

codecov bot commented Feb 27, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 5.55556% with 68 lines in your changes missing coverage. Please review.

Project coverage is 24.53%. Comparing base (1bcbccb) to head (a695aae).
Report is 2 commits behind head on edge.

Files with missing lines Patch % Lines
...ner/ProtocolSteps/Timeline/MultichannelSubstep.tsx 0.00% 47 Missing ⚠️
...esigner/src/organisms/DefineLiquidsModal/index.tsx 0.00% 19 Missing ⚠️
...tocolSteps/StepForm/PipetteFields/PipetteField.tsx 0.00% 1 Missing ⚠️
...esigner/ProtocolSteps/Timeline/SubStepsToolbox.tsx 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             edge   #17602      +/-   ##
==========================================
- Coverage   25.70%   24.53%   -1.17%     
==========================================
  Files        2843     2843              
  Lines      218884   218971      +87     
  Branches    17947    17973      +26     
==========================================
- Hits        56268    53731    -2537     
- Misses     162601   165231    +2630     
+ Partials       15        9       -6
Flag Coverage Δ
app 2.21% <5.55%> (-1.22%) ⬇️
protocol-designer 18.97% <5.55%> (+0.02%) ⬆️
step-generation 4.38% <5.55%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
shared-data/js/liquidClasses.ts 100.00% <100.00%> (ø)
...red_data/liquid_classes/liquid_class_definition.py 95.07% <ø> (ø)
...tocolSteps/StepForm/PipetteFields/PipetteField.tsx 15.38% <0.00%> (-1.29%) ⬇️
...esigner/ProtocolSteps/Timeline/SubStepsToolbox.tsx 3.38% <0.00%> (ø)
...esigner/src/organisms/DefineLiquidsModal/index.tsx 3.49% <0.00%> (-0.22%) ⬇️
...ner/ProtocolSteps/Timeline/MultichannelSubstep.tsx 1.92% <0.00%> (-0.55%) ⬇️

... and 46 files with indirect coverage changes

@ncdiehl11 ncdiehl11 marked this pull request as ready for review February 27, 2025 17:38
@ncdiehl11 ncdiehl11 requested review from a team as code owners February 27, 2025 17:38
@ncdiehl11 ncdiehl11 self-assigned this Feb 27, 2025
@ncdiehl11 ncdiehl11 requested a review from a team as a code owner February 27, 2025 18:38
@ncdiehl11 ncdiehl11 removed request for a team February 27, 2025 19:43
@ncdiehl11 ncdiehl11 requested a review from syao1226 February 27, 2025 20:12
jbleon95
jbleon95 approved these changes Feb 27, 2025
View reviewed changes
Copy link
Contributor

@jbleon95 jbleon95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

schema and python changes look good 👍

@ncdiehl11 ncdiehl11 requested a review from syao1226 February 27, 2025 20:39
syao1226
syao1226 approved these changes Feb 27, 2025
View reviewed changes
Copy link
Collaborator

@syao1226 syao1226 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm in PD!

koji
koji reviewed Feb 27, 2025
View reviewed changes
protocol-designer/src/pages/Designer/ProtocolSteps/Timeline/MultichannelSubstep.tsx
@@ -18,6 +19,7 @@ import type {
StepItemSourceDestRow,
SubstepIdentifier,
} from '../../../../steplist'
import { values } from 'lodash'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can move this up

koji
koji reviewed Feb 27, 2025
View reviewed changes
protocol-designer/src/pages/Designer/ProtocolSteps/Timeline/MultichannelSubstep.tsx
destinations: JSX.Element | null
}

function MultiChannelSubstepButton(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think you can export this as a component?
if exporting doesn't take so much time, I'll recomend you do that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koji koji koji left review comments

@jbleon95 jbleon95 jbleon95 approved these changes

@syao1226 syao1226 syao1226 approved these changes

@sanni-t sanni-t Awaiting requested review from sanni-t

Assignees

@ncdiehl11 ncdiehl11

Labels
authorship
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ncdiehl11 @koji @jbleon95 @syao1226